# eric7.QScintilla.TypingCompleters.CompleterRuby

Module implementing a typing completer for Ruby.

### Global Attributes

None

### Classes

CompleterRuby | Class implementing typing completer for Ruby.

### Functions

createCompleter | Function to instantiate a typing completer object.

## CompleterRuby

Class implementing typing completer for Ruby.

### Derived from

CompleterBase

### Class Attributes

None

### Class Methods

None

### Methods

CompleterRuby | Constructor
__inComment | Private method to check, if the cursor is inside a comment.
__inDoubleQuotedString | Private method to check, if the cursor is within a double quoted string.
__inHereDocument | Private method to check, if the cursor is within a here document.
__inInlineDocument | Private method to check, if the cursor is within an inline document.
__inSingleQuotedString | Private method to check, if the cursor is within a single quoted string.
charAdded | Public slot called to handle the user entering a character.
readSettings | Public slot called to reread the configuration parameters.

### Static Methods

None

#### CompleterRuby (Constructor)

CompleterRuby(editor, parent=None)

Constructor

editor (QScintilla.Editor)
  reference to the editor object
parent (QObject)
  reference to the parent object

#### CompleterRuby.__inComment

__inComment(line, col)

Private method to check, if the cursor is inside a comment.

line (int)
  current line
col (int)
  current position within line

Return:
  flag indicating, if the cursor is inside a comment

Return Type:
  bool

#### CompleterRuby.__inDoubleQuotedString

__inDoubleQuotedString()

Private method to check, if the cursor is within a double quoted string.

Return:
  flag indicating, if the cursor is inside a double quoted string

Return Type:
  bool

#### CompleterRuby.__inHereDocument

__inHereDocument()

Private method to check, if the cursor is within a here document.

Return:
  flag indicating, if the cursor is inside a here document

Return Type:
  bool

#### CompleterRuby.__inInlineDocument

__inInlineDocument()

Private method to check, if the cursor is within an inline document.

Return:
  flag indicating, if the cursor is inside an inline document

Return Type:
  bool

#### CompleterRuby.__inSingleQuotedString

__inSingleQuotedString()

Private method to check, if the cursor is within a single quoted string.

Return:
  flag indicating, if the cursor is inside a single quoted string

Return Type:
  bool

#### CompleterRuby.charAdded

charAdded(charNumber)

Public slot called to handle the user entering a character.

charNumber (int)
  value of the character entered

#### CompleterRuby.readSettings

readSettings()

Public slot called to reread the configuration parameters.

Up

## createCompleter

createCompleter(editor, parent=None)

Function to instantiate a typing completer object.

editor (QScintilla.Editor)
  reference to the editor object
parent (QObject (optional))
  reference to the parent object (defaults to None)

Return:
  reference to the instantiated typing completer object

Return Type:
  CompleterRuby

Up